/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.pulsar.reactive.client.api;

import org.reactivestreams.Publisher;

/**
 * A wrapper exception used by {@link ReactiveMessageSender#sendMany(Publisher)}. The
 * {@link #getMessageSpec()} method will return the message that failed to be sent.
 */
public class ReactiveMessageSendingException extends RuntimeException {

	/**
	 * The message that failed to be sent.
	 */
	private final MessageSpec<?> messageSpec;

	/**
	 * Creates a new instance.
	 * @param cause the cause of the failure
	 * @param messageSpec the message that failed to be sent
	 */
	public ReactiveMessageSendingException(Throwable cause, MessageSpec<?> messageSpec) {
		super(cause);
		this.messageSpec = messageSpec;
	}

	@Override
	public Throwable fillInStackTrace() {
		return this;
	}

	/**
	 * Returns the message that failed to be sent.
	 * @return the message that failed to be sent.
	 */
	public MessageSpec<?> getMessageSpec() {
		return this.messageSpec;
	}

	/**
	 * Returns the correlation metadata of the message that failed to be sent.
	 * @param <C> the correlation metadata type
	 * @return the correlation metadata of the message that failed to be sent.
	 */
	public <C> C getCorrelationMetadata() {
		return this.messageSpec.getCorrelationMetadata();
	}

	@Override
	public String getMessage() {
		return "Message sending failed for message with correlation metadata={" + this.getCorrelationMetadata() + "}";
	}

}
